/*
 *  Copyright 2006-2013 Julien Dufour
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.trazere.util.trigger;

/**
 * The {@link Trigger} class represents triggers.
 */
public interface Trigger {
	/**
	 * Indicate whether the receiver trigger is set.
	 * 
	 * @return <code>true</code> when the trigger is set, <code>false</code> otherwise.
	 */
	public boolean isSet();
	
	/**
	 * Begin a session.
	 * 
	 * @return <code>true</code> when the trigger is being set, <code>false</code> when its state does not changed.
	 */
	public boolean begin();
	
	/**
	 * End a session.
	 * 
	 * @return <code>true</code> when the trigger is being reset, <code>false</code> when its state does not changed.
	 */
	public boolean end();
}
